Method: static {...}

1: /*
2: * *************************************************************************************************************************************************************
3: *
4: * TheseFoolishThings: Miscellaneous utilities
5: * http://tidalwave.it/projects/thesefoolishthings
6: *
7: * Copyright (C) 2009 - 2025 by Tidalwave s.a.s. (http://tidalwave.it)
8: *
9: * *************************************************************************************************************************************************************
10: *
11: * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
12: * You may obtain a copy of the License at
13: *
14: * http://www.apache.org/licenses/LICENSE-2.0
15: *
16: * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
17: * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
18: *
19: * *************************************************************************************************************************************************************
20: *
21: * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
22: * git clone https://github.com/tidalwave-it/thesefoolishthings-src
23: *
24: * *************************************************************************************************************************************************************
25: */
26: package it.tidalwave.role;
27:
28: import jakarta.annotation.Nonnull;
29: import it.tidalwave.util.Finder;
30: import it.tidalwave.util.Finder.SortCriterion;
31: import it.tidalwave.util.Finder.SortDirection;
32:
33: /***************************************************************************************************************************************************************
34: *
35: * The role of an object that has contents that can be sorted.
36: *
37: * @author Fabrizio Giudici
38: * @it.tidalwave.javadoc.stable
39: *
40: **************************************************************************************************************************************************************/
41: public interface Sortable
42: {
43: /** Shortcut for {@link it.tidalwave.util.As}. */
44: public static final Class<Sortable> _Sortable_ = Sortable.class;
45:
46: /***********************************************************************************************************************************************************
47: * A default {@code Sortable} which does nothing (useful for implementing the NullObject pattern). This object always returns
48: * {@link SortCriterion#UNSORTED} as {@code sortCriterion} and {@link SortDirection#ASCENDING} as {@code sortDirection}.
49: **********************************************************************************************************************************************************/
50: public static final Sortable DEFAULT = new Sortable()
51: {
52: @Override
53: public void setSortCriterion (@Nonnull final SortCriterion sortCriterion)
54: {
55: }
56:
57: @Override @Nonnull
58: public SortCriterion getSortCriterion()
59: {
60: return Finder.SortCriterion.UNSORTED;
61: }
62:
63: @Override
64: public void setSortDirection (@Nonnull final SortDirection sortDirection)
65: {
66: }
67:
68: @Override @Nonnull
69: public SortDirection getSortDirection()
70: {
71: return SortDirection.ASCENDING;
72: }
73: };
74:
75: /***********************************************************************************************************************************************************
76: * Sets the sort criterion.
77: * @param sortCriterion the sort criterion
78: **********************************************************************************************************************************************************/
79: @SuppressWarnings("EmptyMethod")
80: public void setSortCriterion (@Nonnull SortCriterion sortCriterion);
81:
82: /***********************************************************************************************************************************************************
83: * Sets the sort direction.
84: * @param sortDirection the sort direction
85: **********************************************************************************************************************************************************/
86: @SuppressWarnings("EmptyMethod")
87: public void setSortDirection (@Nonnull SortDirection sortDirection);
88:
89: /***********************************************************************************************************************************************************
90: * Returns the current sort criterion.
91: * @return the sort criterion
92: **********************************************************************************************************************************************************/
93: @Nonnull @SuppressWarnings("SameReturnValue")
94: public SortCriterion getSortCriterion();
95:
96: /***********************************************************************************************************************************************************
97: * Returns the current sort direction.
98: * @return the sort direction
99: **********************************************************************************************************************************************************/
100: @Nonnull @SuppressWarnings("SameReturnValue")
101: public SortDirection getSortDirection();
102: }